# -*- coding: utf-8 -*-

#This file is part of pyLot library.
#
# pyLot is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# pyLot is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with pyLot.  If not, see <http://www.gnu.org/licenses/>.

__author__ = u'Pierre Puiseux, Guillaume Baty'
__copyright__ = u"Copyright 2011-2012 (C) andheo, Université de Pau et des Pays de l'Adour"
__credits__ = [u'Pierre Puiseux', u'Guillaume Baty']
__license__ = "GNU Lesser General Public License"

from pyLot.core import Book

class MyClass (object) :
  u"""
  This class shows how to document source code in pylot
  """

  def __init__ (self) :
    self.options = Book(u'options')
    # ...

  def getValue (self, key, book=None) :
    u"""
    Looks if an option called 'key' exists in book.
    If true returns it else returns None.
    If book is None, default option book is used.

    :param key: option name
    :type key: :obj:`unicode`
    :param book: option book
    :type book: :class:`~pylot.core.Book`

    :return: corresponding value or None
    :rtype: variable
    """
    # ...

